/*
 * MIT License
 *
 * Copyright (c) 2023 北京凯特伟业科技有限公司
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
package com.je.bpm.engine.management;

import com.je.bpm.engine.internal.Internal;

/**
 * Allows programmatic querying of {@link TablePage}s.
 */
@Internal
public interface TablePageQuery {

    /**
     * The name of the table of which a page must be fetched.
     */
    TablePageQuery tableName(String tableName);

    /**
     * Orders the resulting table page rows by the given column in ascending order.
     */
    TablePageQuery orderAsc(String column);

    /**
     * Orders the resulting table page rows by the given column in descending order.
     */
    TablePageQuery orderDesc(String column);

    /**
     * Executes the query and returns the {@link TablePage}.
     */
    TablePage listPage(int firstResult, int maxResults);
}
